home *** CD-ROM | disk | FTP | other *** search
/ Aminet 45 / Aminet 45 (2001)(GTI - Schatztruhe)[!][Oct 2001].iso / Aminet / game / role / ldmud-3.2-bin.lha / mud / doc / README < prev    next >
Text File  |  2001-04-23  |  3KB  |  89 lines
  1. NAME
  2.     doc/README
  3.  
  4.  
  5. DESCRIPTION
  6.     These man pages are organised in chapters, that are stored in
  7.     separate directories. A reference to foo(X) means the function
  8.     foo as descibed in chapter X, where X is one of:
  9.  
  10.     A for applied/    member functions (lfuns) that the driver applies
  11.             to objects
  12.     C for concepts/    general concepts of LPMUD and LPC
  13.     D for driver/    some info about internal operation of the driver
  14.     E for efun/    the ``system calls'' of LPC
  15.     LPC for LPC/    about parts of the LPC language
  16.     M for master/    lfuns that are applied to the master object only
  17.  
  18.      This collection does not contain anything about mudlib specific
  19.     object classes or lfuns, and also not about any simulated
  20.     efuns (from the simul_efun object), because all these are not
  21.     specific for the driver but for the particular installation.
  22.  
  23.     Man-pages for the functions in the installation's simul_efun
  24.     object could go e.g. into the chapter SE (directory sefun/),
  25.     man pages for the standard objects (base classes) of the mudlib
  26.     would e.g. fit into chapter S (directory std/).
  27.  
  28.  
  29.     The man pages generally adhere to the following format, which
  30.     was inspired by the Unix man pages.
  31.  
  32.     <manpage> ::= <section>+
  33.  
  34.     There are one or more sections in a man page.
  35.  
  36.     <section> ::= <section-name><newline><section-text><newline>
  37.  
  38.     The section names are always at the beginning of a line, and
  39.     in all capital letters (debatable uglyness).
  40.  
  41.     <section-name> ::=   'NAME' | 'CONCEPT' | 'SYNOPSIS'
  42.                | 'LAST UPDATED'
  43.                | 'SYNTAX' | 'DESCRIPTION' | 'AUTHOR' | 'BUGS'
  44.                | 'CAVEATS' | 'WARNING' | 'NOTE' | 'NOTES'
  45.                | 'EXAMPLE' | 'EXAMPLES' | 'HISTORY'
  46.                | 'SEE ALSO'
  47.  
  48.     If a NAME or CONCEPT section occurs, it should give the name of
  49.     the man page.
  50.     If a SYNOPSIS section occurs, the name of the man page can be
  51.     derived from the function name, that appears in the line after
  52.     SYNOPSIS, which looks as follows:
  53.  
  54.     <returntype><space>['*']<function-name>'('<parameter-prototypes>
  55.  
  56.     SEE ALSO is followed by one or more lines that contain
  57.     crossreferences of the form
  58.  
  59.     <crossreferences> ::=
  60.         <crossref>[','<white-space><crossref>]*<white-space><EOF>
  61.     <crossref> ::= <man-page-name>'('<chapter-abbrev>')'
  62.  
  63.     The names of the referenced man pages are followed in brackets
  64.     by an abbreveiation for the chaper (i.e. directory) the man
  65.     page is in. The abbrevs are
  66.  
  67.     If you want to process these man pages by some converter
  68.     program, you can use these to map the chapter names to file
  69.     names or whatever. There should be some sample awk scripts or
  70.     the like near this README file.
  71.  
  72. HISTORY
  73.         Most of the documentation is based on the 'driver-docs' collected
  74.         by Stefan 'Pepel' Petri up to Amylaar LPMud 3.2.1@141 and 3.2@316.
  75.         It was collectect from the original 2.4.5 docs, from the installed
  76.         docs of Nightfall, TubMud and MorgenGrauen.
  77.  
  78.     Collection, correction and completion was done by Pepel@Nightfall,
  79.     with assistance and support by the LPC wizards of Nightfall,
  80.     TubMud, MorgenGrauen and TAPPMud, namely Hyp, Macbeth,
  81.     Mateese, and Marcus. Also to mention are Bumblebee, Boing,
  82.     Deepthought, Demos, Hate, Jof, Symmetry@TMI2.
  83.  
  84.         The documentation was integrated into the driver distribution
  85.         in LDMud 3.2.6.
  86.  
  87. SEE ALSO
  88.     efun(E), applied(A), concepts(C), lpc(LPC), master(M), driver(D)
  89.